Skip to content

SK-3068: Fix README API examples in both SDK READMEs - #197

Merged
saileshwar-skyflow merged 1 commit into
mainfrom
saileshwar/SK-3068-fix-readme-samples
Aug 25, 2026
Merged

SK-3068: Fix README API examples in both SDK READMEs#197
saileshwar-skyflow merged 1 commit into
mainfrom
saileshwar/SK-3068-fix-readme-samples

Conversation

@saileshwar-skyflow

Copy link
Copy Markdown
Collaborator

Fixes pre-existing API-example errors in both SDK READMEs. Doc-only — no SDK/source changes, so skyvault stays byte-identical to 1.27.0.

Changes (both flowvault/README.md and skyvault/README.md)

  • Skyflow.ElementTypeSkyflowElementType — the actual enum name (the old form never compiled); the SDK has used SkyflowElementType since 1.27.0.
  • ElementMatchRuleElementValueMatchRule — the actual class name in the custom-validation example.
  • Added the required context argument to container.create() examples that omitted it.

The element-creation and custom-validation snippets now compile against the shipped API. The samples were already correct — only the READMEs were out of date.

🤖 Generated with Claude Code

- Skyflow.ElementType -> SkyflowElementType (actual enum name)
- ElementMatchRule -> ElementValueMatchRule (actual class name)
- add missing context arg to container.create() examples

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

Gitleaks Findings: No secrets detected. Safe to proceed!

@github-actions

Copy link
Copy Markdown

Semgrep Findings: Issues with Error level severity are found (Error is Highest severity in Semgrep), Please resolve the issues before merging.

@saileshwar-skyflow
saileshwar-skyflow merged commit 122cf11 into main Aug 25, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants